/**
 * Copyright 2008 Matthew Purland (m.purland@gmail.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.variance.version;

/**
 * Provides a transaction for a number of revisions.
 *
 * @author Matthew Purland
 */
public interface RevisionTransaction {
    /**
     * Begin a new transaction.
     */
    void begin();

    /**
     * Close the transaction.  This will void all actions and
     * will rollback any actions not committed.
     */
    void close();

    /**
     * Rollback the transaction.
     */
    void rollback();

    /**
     * Flush and commit the transaction to the underlying data source.
     */
    void commit();

    /**
     * Has the transaction been committed since there was new data?
     *
     * @return True if the transaction has been committed; false otherwise.
     */
    boolean wasCommitted();

    /**
     * Was the transaction rolled back?
     *
     * @return True if the transaction was rolled back; false otherwise.
     */
    boolean wasRolledBack();
}
